/*
 * Copyright (c) 2008 VMware, Inc.
 * Copyright (c) 2009 John Pritchard, WTKX Project Group
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package wtkx;

import jbxml.Dictionary;

import java.io.IOException;

/**
 * Represents the entry point into a WTK application.
 *
 * @author gbrown
 * @author jdp
 */
public interface Application {

    public final static String PARAM = "wtkx";

    /**
     * Called when the application is starting up.
     *
     * @param scene
     * The scene on which this application was started.
     *
     * @param properties
     * Initialization properties passed to the application.
     */
    public void startup(Scene scene, Dictionary<String, String> properties) throws IOException;

    /**
     * Called when the application is being shut down.
     */
    public void shutdown() throws IOException;

    /**
     * Called to notify the application that it is being suspended.
     */
    public void suspend();

    /**
     * Called when a suspended application has been resumed.
     */
    public void resume();
}
